POST Podcast RSS Link
Overview
The following table contains information about the POST
method for manually triggering an RSS Synchronization of the Podcast
POST Manually Trigger RSS Synchronization of the Podcast | |
---|---|
Method | POST |
URL or Endpoint | /api/v1/projectId /podcasts/rss/sync |
Headers | Authorization |
Parameters | projectId |
Body | Check the request body below. |
The description of the URL parameter is as follows:
projectId Parameter | |
---|---|
URL Parameter Name | projectId |
Mandatory | Yes |
Type | string |
Description | Unique Id of the project. |
Request Body
{
"podcastId": "string",
"podcastUrl": "string",
}
Information about the fields that appear on the request body are displayed in the table below.
Parameter Name | Mandatory | Type | Description |
---|---|---|---|
podcastId | Yes | string | Unique identifier of the podcast |
podcastUrl | Yes | string | URL of the podcast RSS feed |
Response
{
"success": true,
"errors": [],
"messages": [],
"result": {
"isSuccess": true
},
"resultInfo": null,
"statusCode": 200
}
Information about the fields that appear when you receive the response are displayed in the table below.
<table>
<thead>
<tr>
<th>Field Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tr>
<td>success</td>
<td>bool</td>
<td>If the response is successful it will return true. Otherwise, it will return false</td>
</tr>
<tr>
<td>errors</td>
<td>array[string]</td>
<td>Indicates if there was an error</td>
</tr>
<tr>
<td>messages</td>
<td>array[string]</td>
<td>Returns the response message from back-end</td>
</tr>
<tr>
<td>result</td>
<td>Object</td>
<td>Returns the response object</td>
</tr>
<tr>
<td>isSuccess</td>
<td>bool</td>
<td>Indicates if the result was successful</td>
</tr>
<tr>
<td>resultInfo</td>
<td>string</td>
<td>Returns extra information about the result</td>
</tr>
<tr>
<td>statusCode</td>
<td>integer</td>
<td>Returns the HTTP Status Code</td>
</tr>
</table>
If the action is successful, the service sends back an HTTP 200 or 201 response.
Errors
For information about the errors that are common to all actions, see Common Errors:
HTTP Status Code 400: Bad Request
HTTP Status Code 401: Unauthorized
HTTP Status Code 403: Forbidden
HTTP Status Code 404: Result Not Found
HTTP Status Code 500: Internal Server Error
HTTP Status Code 503: Backend Fetch Failed